#ifndef _WX_PROCESSH__
#define _WX_PROCESSH__

#include "wx/event.h"

#if wxUSE_STREAMS
#include "wx/stream.h"
#endif

#include "wx/utils.h"       // for wxSignal

// the wxProcess creation flags
enum {
  // no redirection
  wxPROCESS_DEFAULT = 0,

  // redirect the IO of the child process
  wxPROCESS_REDIRECT = 1
};

// ----------------------------------------------------------------------------
// A wxProcess object should be passed to wxExecute - than its OnTerminate()
// function will be called when the process terminates.
// ----------------------------------------------------------------------------

class wxProcess : public wxEvtHandler {
  public:
    // kill the process with the given PID
    static wxKillError Kill( int pid, wxSignal sig = wxSIGTERM, int flags = wxKILL_NOCHILDREN );

    // test if the given process exists
    static bool Exists( int pid );

    // this function replaces the standard popen() one: it launches a process
    // asynchronously and allows the caller to get the streams connected to its
    // std{in|out|err}
    //
    // on error NULL is returned, in any case the process object will be
    // deleted automatically when the process terminates and should *not* be
    // deleted by the caller
    static wxProcess *Open( const wxString& cmd, int flags = wxEXEC_ASYNC );


    // ctors
    wxProcess( wxEvtHandler *parent = ( wxEvtHandler * ) NULL, int nId = wxID_ANY ) { Init( parent, nId, wxPROCESS_DEFAULT ); }

    wxProcess( int flags ) { Init( NULL, wxID_ANY, flags ); }

    virtual ~wxProcess();

    // get the process ID of the process executed by Open()
    long GetPid() const { return m_pid; }

    // may be overridden to be notified about process termination
    virtual void OnTerminate( int pid, int status );

    // call this before passing the object to wxExecute() to redirect the
    // launched process stdin/stdout, then use GetInputStream() and
    // GetOutputStream() to get access to them
    void Redirect() { m_redirect = true; }
    bool IsRedirected() const { return m_redirect; }

    // detach from the parent - should be called by the parent if it's deleted
    // before the process it started terminates
    void Detach();

    #if wxUSE_STREAMS
    // Pipe handling
    wxInputStream *GetInputStream() const { return m_inputStream; }
    wxInputStream *GetErrorStream() const { return m_errorStream; }
    wxOutputStream *GetOutputStream() const { return m_outputStream; }

    // close the output stream indicating that nothing more will be written
    void CloseOutput() { delete m_outputStream; m_outputStream = NULL; }

    // return true if the child process stdout is not closed
    bool IsInputOpened() const;

    // return true if any input is available on the child process stdout/err
    bool IsInputAvailable() const;
    bool IsErrorAvailable() const;

    // implementation only (for wxExecute)
    //
    // NB: the streams passed here should correspond to the child process
    //     stdout, stdin and stderr and here the normal naming convention is
    //     used unlike elsewhere in this class
    void SetPipeStreams( wxInputStream *outStream,
                         wxOutputStream *inStream,
                         wxInputStream *errStream );
    #endif // wxUSE_STREAMS

  protected:
    void Init( wxEvtHandler *parent, int id, int flags );
    void SetPid( long pid ) { m_pid = pid; }

    int m_id;
    long m_pid;

    #if wxUSE_STREAMS
    // these streams are connected to stdout, stderr and stdin of the child
    // process respectively (yes, m_inputStream corresponds to stdout -- very
    // confusing but too late to change now)
    wxInputStream  *m_inputStream,
                   *m_errorStream;
    wxOutputStream *m_outputStream;
    #endif // wxUSE_STREAMS

    bool m_redirect;

    DECLARE_DYNAMIC_CLASS( wxProcess )
    DECLARE_NO_COPY_CLASS( wxProcess )
};

// ----------------------------------------------------------------------------
// wxProcess events
// ----------------------------------------------------------------------------

BEGIN_DECLARE_EVENT_TYPES()
DECLARE_EXPORTED_EVENT_TYPE( wxEVT_END_PROCESS, 440 )
END_DECLARE_EVENT_TYPES()

class wxProcessEvent : public wxEvent {
  public:
    wxProcessEvent( int nId = 0, int pid = 0, int exitcode = 0 ) : wxEvent( nId ) {
      m_eventType = wxEVT_END_PROCESS;
      m_pid = pid;
      m_exitcode = exitcode;
    }

    // accessors
    // PID of process which terminated
    int GetPid() { return m_pid; }

    // the exit code
    int GetExitCode() { return m_exitcode; }

    // implement the base class pure virtual
    virtual wxEvent *Clone() const { return new wxProcessEvent( *this ); }

  public:
    int m_pid,
        m_exitcode;

    DECLARE_DYNAMIC_CLASS_NO_ASSIGN( wxProcessEvent )
};

typedef void ( wxEvtHandler::*wxProcessEventFunction )( wxProcessEvent& );

#define wxProcessEventHandler(func) \
  (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxProcessEventFunction, &func)

#define EVT_END_PROCESS(id, func) \
  wx__DECLARE_EVT1(wxEVT_END_PROCESS, id, wxProcessEventHandler(func))

#endif // _WX_PROCESSH__
